chore: sync with module template #76

oycyc · 2025-06-16T18:58:01Z

Use our Taskfile to sync our .github files to be consistent with the module template repository workflows

This will address the pending checks here: #75

Summary by CodeRabbit

Chores
- Updated lint workflow to use pull_request_target trigger and inject GITHUB_TOKEN for improved linter support.
- Modified release workflow to authenticate using a GitHub App token for the release process.
- Simplified trunk upgrade workflow by automating PR merges with improved token usage and streamlined commands.

coderabbitai · 2025-06-16T18:59:14Z

Walkthrough

This set of changes updates three GitHub Actions workflow files. In the lint workflow, the trigger event is switched from pull_request to pull_request_target, and a GITHUB_TOKEN environment variable is added for the tflint linter step. The release-please workflow is modified to generate and use a GitHub App token for authentication, replacing the default token. The trunk-upgrade workflow simplifies the merge step by replacing explicit polling for status checks with a single gh pr merge --auto command and updates the environment variable name for the token.

Possibly related PRs

fix(gha): wait for checks and merge with admin #71: Simplifies the merge step in the trunk-upgrade workflow, closely mirroring the change from polling to gh pr merge --auto.
fix(gha): use app–generated token to create release-please PRs terraform-module-template#45: Alters the release-please workflow to use a GitHub App token for authentication, directly relating to the authentication update in this PR.
fix(gha-lint): allow lint workflow to be triggered by github-actions[bot] terraform-module-template#41: Changes the lint workflow trigger from pull_request to pull_request_target, matching the trigger modification in this PR.

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b19e782 and bf95a06.

📒 Files selected for processing (3)

.github/workflows/lint.yaml (2 hunks)
.github/workflows/release-please.yaml (1 hunks)
.github/workflows/trunk-upgrade.yaml (1 hunks)

🔇 Additional comments (5)

.github/workflows/release-please.yaml (2)

17-23: New GitHub App authentication step looks solid
The tibdex/github-app-token action is correctly configured to generate a GitHub App token. Ensure your MP_BOT_APP_PRIVATE_KEY secret is rotated regularly and the App has adequate repo installation permissions.

26-26: Explicitly passing the generated token
Replacing the implicit token with ${{ steps.generate-token.outputs.token }} is a good move for scoped auth.

.github/workflows/lint.yaml (2)

7-7: Verify security implications of pull_request_target
Switching to pull_request_target grants PR workflows access to base-branch secrets—double-check that this doesn’t expose sensitive operations to untrusted code.

23-27: Injecting GITHUB_TOKEN for tflint rate-limit avoidance
Adding GITHUB_TOKEN to the Trunk Check step aligns with the tflint plugin docs and prevents API throttling.

.github/workflows/trunk-upgrade.yaml (1)

37-44: Streamlined PR merge via GitHub CLI
Using gh pr merge --auto simplifies polling for checks. Confirm that gh on ubuntu-latest supports --auto and that your MasterpointBot App token has pull-requests: write & contents: write permissions.

✨ Finishing Touches

🧪 Generate Unit Tests

Create PR with Unit Tests
Commit Unit Tests in branch chore/sync-with-template
Post Copyable Unit Tests in Comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai auto-generate unit tests to generate unit tests for this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

oycyc · 2025-06-16T19:00:58Z

@Gowiem agh this is going to require an admin merge because of the chicken and egg problem with hte pull_request_target

Gowiem · 2025-06-16T19:04:45Z

.github/workflows/trunk-upgrade.yaml

-          echo "Waiting for required status checks to pass on PR #$PR_NUMBER..."
-          while true; do
-            CHECKS_JSON=$(gh pr checks "$PR_NUMBER" --required --json state,bucket)
-            echo "Current checks status: $CHECKS_JSON"
-
-            if echo "$CHECKS_JSON" | jq -e '.[] | select(.bucket=="fail")' > /dev/null; then
-              echo "One or more required checks have failed. Exiting..."
-              exit 1
-            fi
-
-            FAILED_OR_PENDING_CHECKS=$(echo "$CHECKS_JSON" | jq '[.[] | select(.state!="SUCCESS" or .bucket!="pass")] | length')
-            if [ "$FAILED_OR_PENDING_CHECKS" -eq 0 ]; then
-              echo "All required checks passed. Merging PR #$PR_NUMBER..."
-              gh pr merge "$PR_NUMBER" --squash --delete-branch --admin
-              break
-            else
-              echo "Some required checks are still running or pending. Retrying in 30s..."
-              sleep 30
-            fi
-          done
+          gh pr merge "$PR_NUMBER" --squash --auto --delete-branch


I think @gberenice wanted to keep this... but we'll let her weigh in tomorrow. We can revert if needed...

Yep good call out. Looking at her PR, she wrote that she'll propagate it to the module template repository afterwards: #71.

I've made this PR simply to just update the release-please.yaml file to avoid any other conflicts.

Gowiem

Gowiem

🚢

oycyc requested a review from Gowiem June 16, 2025 18:58

oycyc requested a review from a team as a code owner June 16, 2025 18:58

Gowiem reviewed Jun 16, 2025

View reviewed changes

Gowiem previously approved these changes Jun 16, 2025

View reviewed changes

chore: sync with module template

23e626d

oycyc dismissed Gowiem’s stale review via 23e626d June 16, 2025 19:07

oycyc force-pushed the chore/sync-with-template branch from bf95a06 to 23e626d Compare June 16, 2025 19:07

oycyc requested a review from Gowiem June 16, 2025 19:07

oycyc enabled auto-merge (squash) June 16, 2025 19:08

Gowiem approved these changes Jun 16, 2025

View reviewed changes

oycyc merged commit a170ab4 into main Jun 16, 2025
5 checks passed

oycyc deleted the chore/sync-with-template branch June 16, 2025 19:13

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

chore: sync with module template #76

chore: sync with module template #76

Uh oh!

oycyc commented Jun 16, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Jun 16, 2025

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

Uh oh!

oycyc commented Jun 16, 2025

Uh oh!

Gowiem Jun 16, 2025

Uh oh!

oycyc Jun 16, 2025

Uh oh!

Gowiem left a comment

Uh oh!

Gowiem left a comment

Uh oh!

Uh oh!

Uh oh!

chore: sync with module template #76

chore: sync with module template #76

Uh oh!

Conversation

oycyc commented Jun 16, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Jun 16, 2025

Walkthrough

Possibly related PRs

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

Uh oh!

oycyc commented Jun 16, 2025

Uh oh!

Gowiem Jun 16, 2025

Choose a reason for hiding this comment

Uh oh!

oycyc Jun 16, 2025

Choose a reason for hiding this comment

Uh oh!

Gowiem left a comment

Choose a reason for hiding this comment

Uh oh!

Gowiem left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

oycyc commented Jun 16, 2025 •

edited by coderabbitai bot

Loading